Skip to content

Feature/http api new approach #348

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 122 commits into
base: main
Choose a base branch
from
Draft

Feature/http api new approach #348

wants to merge 122 commits into from

Conversation

Jan-Schuppik
Copy link

@Jan-Schuppik Jan-Schuppik commented Aug 22, 2025 •
edited
Loading

@Jan-Schuppik Jan-Schuppik requested a review from nilmerg August 22, 2025 13:51
@Jan-Schuppik Jan-Schuppik self-assigned this Aug 22, 2025
@cla-bot cla-bot bot added the cla/signed CLA is signed by all contributors of a PR label Aug 22, 2025
@Jan-Schuppik Jan-Schuppik force-pushed the feature/http-api-new-approach branch from 9a3a6aa to aa2b625 Compare August 25, 2025 12:48
nilmerg
nilmerg requested changes Aug 26, 2025
View reviewed changes
Copy link
Member

@nilmerg nilmerg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This review covers only the early parts of routing and dispatching.

@nilmerg
Copy link
Member

nilmerg commented Aug 26, 2025

Oh, and I got the postgres tests working in my environment. Please get back to me for this.

This was referenced Sep 3, 2025
Open
Closed
@Jan-Schuppik Jan-Schuppik force-pushed the feature/http-api-new-approach branch 2 times, most recently from 1705125 to fe816f8 Compare September 3, 2025 10:58
@Jan-Schuppik Jan-Schuppik mentioned this pull request Sep 5, 2025
Merged
sukhwinder33445
sukhwinder33445 reviewed Sep 8, 2025
View reviewed changes
sukhwinder33445
sukhwinder33445 reviewed Sep 9, 2025
View reviewed changes
sukhwinder33445
sukhwinder33445 reviewed Sep 11, 2025
View reviewed changes
Copy link
Contributor

@sukhwinder33445 sukhwinder33445 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have looked at channels and contact tests so far, next I will look at contactgroup tests.

sukhwinder33445
sukhwinder33445 reviewed Sep 11, 2025
View reviewed changes
sukhwinder33445
sukhwinder33445 reviewed Sep 18, 2025
View reviewed changes
sukhwinder33445
sukhwinder33445 reviewed Sep 19, 2025
View reviewed changes
sukhwinder33445
sukhwinder33445 reviewed Sep 19, 2025
View reviewed changes
sukhwinder33445
sukhwinder33445 reviewed Sep 19, 2025
View reviewed changes
sukhwinder33445
sukhwinder33445 reviewed Sep 19, 2025
View reviewed changes
sukhwinder33445
sukhwinder33445 reviewed Sep 19, 2025
View reviewed changes
sukhwinder33445
sukhwinder33445 reviewed Sep 19, 2025
View reviewed changes
sukhwinder33445
sukhwinder33445 reviewed Sep 25, 2025
View reviewed changes
Copy link
Contributor

@sukhwinder33445 sukhwinder33445 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add following changes as well:

  • The PHPDoc for the method must contain a newline between different annotations, i.e. @param, @return.
  • Update method PHPDoc if required.
  • Make the getPlural() method protected.
  • Remove the resolved todos.

@Jan-Schuppik Jan-Schuppik force-pushed the feature/http-api-new-approach branch from 30b0b1b to da665ca Compare September 26, 2025 09:01
sukhwinder33445
sukhwinder33445 reviewed Sep 26, 2025
View reviewed changes
sukhwinder33445
sukhwinder33445 requested changes Sep 29, 2025
View reviewed changes
nilmerg
nilmerg requested changes Oct 8, 2025
View reviewed changes
Copy link
Member

@nilmerg nilmerg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's discuss how we handle the openapi description and the usage of Swagger, as there are three possible solutions for me:

  • Caching (properly, not the way it's right now ;) )
  • CI (as your todo suggests)
  • Static (it's a versioned api after all)

application/controllers/ApiController.php Outdated
{
if (
! preg_match('/([^;]*);?/', $request->getHeader('Content-Type'), $matches)
|| $matches[1] !== 'application/json'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • ApiV1::getValidRequestBody() throws in this case
  • This returns null, effectively preventing any handling of non-JSON

I must ask: Why does this not throw already? Or why does it check for JSON?

application/controllers/ApiController.php
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing license header. It seems, not only this file is missing it, please make sure all PHP files have one.

Jan-Schuppik and others added 26 commits October 15, 2025 16:35
@Jan-Schuppik
Fix: Code-Sniffer Errors
fcd79f2
@Jan-Schuppik
Fix: softdelete-blocks-uuid problem
5959e1f
@nilmerg @Jan-Schuppik
php: Spin up database backends for unit tests
7bba0f1
@nilmerg @Jan-Schuppik
tests: Set up Icinga Web Database
048e39b
@nilmerg @Jan-Schuppik
ApiTestBackends: Pass through ICINGAWEB_LIBDIR to webserver
32b78fe
@Jan-Schuppik
Adjust: implement HandlerInterface in endpoints instead of in base class
7cdbe98
@Jan-Schuppik
Fix: Error-handling, log no-http-errors
8850461
@Jan-Schuppik
Fix: psr logger
c864495
@Jan-Schuppik
Fix: stream the response
9e5bd80
@Jan-Schuppik
Fix: ServerRequest creation, avoid Content-type checking
481cb98
@Jan-Schuppik
Fix: web-forms add column external_uuid
4a9f31e
@Jan-Schuppik
Adjust: wrapping-condition of result data in tests
40cc67a
@Jan-Schuppik
Fix: HttpMethod enum
a751d49
@Jan-Schuppik
Adjust: check if http method exists for endpoint
bb966be
@Jan-Schuppik
Add: license headers
8beb160
@Jan-Schuppik
Adjust: replace PHP-docs with more descriptive test-names
5494522
@Jan-Schuppik
Introduce: own handling of swagger-php attributes (start with GET)
697c98c
@Jan-Schuppik
Add: DELETE swagger-php attributes
70d73eb
@Jan-Schuppik
Add: POST swagger-php attributes
6289d7e
@Jan-Schuppik
Add: PUT swagger-php attributes
ff4188f
@Jan-Schuppik
WIP: Adjust openapi description according to schemathesis checks
c0fe743
@Jan-Schuppik
Adjust: cleanup OpenApi Description
e06838d
@Jan-Schuppik
Adjust: give the POST request body a new uuid
26307e8
@Jan-Schuppik
Fix: standardize the designation of Contact Groups
3526533
@Jan-Schuppik
Fix: output format of a single get result
c774c90
@Jan-Schuppik
Add: missing license headers (to OAD files)
00d3880
@Jan-Schuppik Jan-Schuppik force-pushed the feature/http-api-new-approach branch from ad9e5e8 to 00d3880 Compare October 15, 2025 14:44
@Jan-Schuppik Jan-Schuppik force-pushed the feature/http-api-new-approach branch from 3863707 to 06a2750 Compare October 15, 2025 14:51
nilmerg
nilmerg requested changes Oct 16, 2025
View reviewed changes
Copy link
Member

@nilmerg nilmerg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't worry, I didn't take a look at the validation/middleware stuff again 😜

application/controllers/ApiController.php
$response = new Response(
500,
['Content-Type' => 'application/json'],
Json::sanitize(['message' => 'An error occurred, please chack the log.'])
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo

library/Notifications/Common/PsrLogger.php
* @param string $message The log message
* @param array $context Additional context variables to interpolate in the message
*/
public function log($level, $message, array $context = []): void
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$message isn't typed yet

library/Notifications/Api/OpenApiDescriptionElements/Responses/SuccessDataResponse.php

namespace Icinga\Module\Notifications\Api\OpenApiDescriptionElements\Responses;

use cebe\openapi\spec\Parameter;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unused, pls remove

library/Notifications/Api/Util/BinaryUuidConverter.php

namespace Icinga\Module\Notifications\Api\Util;

class BinaryUuidConverter
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this keeps being unused, please drop it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nilmerg nilmerg nilmerg requested changes

@sukhwinder33445 sukhwinder33445 sukhwinder33445 requested changes

Requested changes must be addressed to merge this pull request.

Assignees

@Jan-Schuppik Jan-Schuppik

Labels

cla/signed CLA is signed by all contributors of a PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Jan-Schuppik @nilmerg @sukhwinder33445